//===============================================================================
// Microsoft patterns & practices
// Web Client Software Factory
//-------------------------------------------------------------------------------
// Copyright (C) Microsoft Corporation.  All rights reserved.
// THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY
// OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT
// LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
// FITNESS FOR A PARTICULAR PURPOSE.
//-------------------------------------------------------------------------------
// The example companies, organizations, products, domain names,
// e-mail addresses, logos, people, places, and events depicted
// herein are fictitious.  No association with any real company,
// organization, product, domain name, email address, logo, person,
// places, or events is intended or should be inferred.
//===============================================================================
using System.Collections;

namespace WCSFContrib.PageFlow
{
	/// <summary>
	/// An abstract definition of a persistence store for PageFlow state
	/// </summary>
	public abstract class PageFlowState
	{
		/// <summary>
		/// Gets a collection of keys.
		/// </summary>
		public abstract ICollection Keys { get; }

		/// <summary>
		/// Gets or sets the value of a particular key.
		/// </summary>
		/// <param name="key">The key to set the value of</param>
		/// <returns>An object.</returns>
		public abstract object this[string key] { get; set; }

		/// <summary>
		/// Determines if the store contains the specified key.
		/// </summary>
		/// <param name="key">The key to search for.</param>
		/// <returns>true if the store contains the key.</returns>
		public abstract bool Contains(string key);

		/// <summary>
		/// Removes a key from the store.
		/// </summary>
		/// <param name="key">The key to remove.</param>
		public abstract void Remove(string key);
	}
}
